BBS Toolkit/BBS Toolkit.iso/doors_2/rdrm20.zip/READROOM.DOC

Text File | 1993-04-19 | 24KB | 518 lines

                ┌─────────────────────────────────────────┐
                │                READROOM                 │
                │      Online Periodical Viewing Door     │
                │ (C) Exhibit A Communications, 1992-1993 │
                └─────────────────────────────────────────┘



┌────────────────────┐
│  About READROOM    │
└────────────────────┘

        READROOM is an online viewing door that provides an environment
for all of your online publications.  READROOM will provide your users a
choice between up to 99 different publications, each with up to 99
different articles.  This door supports ASCII, ANSI text and ANSIART file
viewing.

        READROOM will work with any BBS that can produce a DOOR.SYS file,
either directly, or using a conversion program. READROOM can also, optionally,
allow the user to download the currently selected periodical using sysop
defined transfer protocols.

        Advanced Features in this version include the ability to define
a logfile to track who opens a given publication.  Sysops can also set
separate security levels for each publication if they so desire.

        Sysop's can chat with users with full wordwrapping, drop to DOS
or twit the caller without the caller ever knowing the sysop is
watching.

        READROOM is fully interupt driven, so there should be no
need to use fossil drivers.  It also handles data transfer at rates up
to 115,200 baud as well as handle communication ports other than Com1 or
Com2.  Contains it's own ANSI driver.  Also supports the 16550 UART
chips through the FIFO buffers.



┌────────────────────┐
│  About Shareware   │
└────────────────────┘

        Shareware is a method of software distribution designed to benefit
both the software developer and the end user.  Shareware (SW) should not
be confused with Public Domain (PD) programs.  While  PD programs are
released to the public with no restrictions attached to their use, SW
programs are the copyrighted work of their authors.  The SW programs are
released to the public for evaluation purposes under the assumption that
if the end user likes the program and continues to use it after a
reasonable period of time, that user is obligated to register the
program.
        If you purchased this program from a SW distributor, you have
not registered it.  You must still pay the programmer to register it.
The money you paid to the distributor was to cover the cost of
duplicating/advertising/etc the files.
        Programmers get to distribute their wares without the expense
of advertising, packaging & distribution.  The users benefit from being
able to try out the programs without having to pay for the privilege of
evaluation.  Shareware programmers (the good ones anyway) are generally
more responsive to bug reports & user requests for additional features.
Everyone benefits provided that the users remember to register and
programmers continue to ... well, program<G>.

┌────────────────────┐
│  Registration      │
└────────────────────┘

        Please fill out the file ORDER.FRM, copy it to your printer
and mail it along with a check for $15.00 to Exhibit A Communications
at the address shown on the form.

        Or if you want to register painlessly, you can now register
READROOM on CompuServe.  Just GO SWREG at any prompt.  Cost is the same
to you and you don't have to mess with U. S(nail). Mail at all.

        By sending in your registration fee, you will be entitled to
the following:
        0) Enable use of IMPORT program.  Does not work in unregistered ver.
        1) Removal of the UNREGISTERED message when door closes
        2) Continued use of this program on any single or multiuser BBS
        3) Free upgrades to future versions
        4) Enhanced support from programmer
        5) The satisfaction of knowing that you are helping to make the
                shareware system alive
        6) A jump to the next Karma level
        7) The undying gratitude of my wife, son and dog <g>


┌────────────────────┐
│  Requirements      │
└────────────────────┘

        1) READROOM will only run on a BBS system that is capable of
                creating a DOOR.SYS file when a user opens a door.
                If your BBS will not create a DOOR.SYS file, there are
                conversion programs around to create a DOOR.SYS file
                from whatever your system creates.  I strongly suggest
                that you ask your BBS software's author to support the
                DOOR.SYS standard!

        2) READROOM also relies heavily on the READROOM.TOC file for
                simplifying the setup and maintenance of your
                publications (see below).  If your favorite online
                publication isn't shipped with this file, encourage the
                publishers to support this standard.  Otherwise, you'll
                have to do it yourself! <g>

        3) If you wish to allow users to download publications, you will
                need an external file transfer protocol program.  The
                sample batch files are for DSZ, but any should do.

┌────────────────────┐
│  Installation      │
└────────────────────┘

        To install READROOM, simply copy all the files included in the
original distribution disk (or archive file) into a single directory.
The only files absolutely necessary to the operation of READROOM are:
        READROOM.EXE
        a configuration file
        and a READROOM.TOC file in same directory as the articles

        To install the sample files, please create a subdirectory to hold
the files in SAMPLE.ZIP.  Copy SAMPLE.ZIP into the subdirectory and then
unzip it and continue with installing the door as below.

        You will want to use a text editor to open READROOM.CNF or create
a new .CNF file.  The Configuration format is as follows:
D:\GAP
InfoMat BBS
0
0
00000.0000000000
Your Name Here
D:\HOLDING
WELCOME
EXIT
Publications that support the READROOM.TOC format
H:\READROOM\SAMPLE
YES
RESERVED

Each line will be explained below:

1)      This is the directory where READROOM will find the DOOR.SYS file
        created by your BBS software when a user opens a door.

2)      This is the name of your BBS.

3)      This is the IRQ that should be used for the com port that you
        are using UNLESS you are using COM1 or COM2 in which case you
        will put a 0 here.

4)      This is the Base Port Address for the com port that you are
        using UNLESS you are using COM1 or COM2 in which case you will
        put a 0 here.

5)      This is where you will place your registration number you
        receive from Exhibit A Communications upon registering READROOM.

6)      This is where you will place your name, exactly as given to you
        when you register the program.  Case is important!

7)      This line is the full drive\path to the holding directory where
        IMPORT will look for new publications.  If you don't plan on
        using the IMPORT utility, then just leave this line blank.
        (Please see IMPORT.DOC for information on this utility)

8)      This is the name of the file (including path if not in same
        directory where READROOM.EXE is located) you wish to show users
        when they first enter this door.  If you don't wish to utilize
        this feature, leave this line blank.

9)      This is the name of the file (including path if not in same
        directory where READROOM.EXE is located) you wish to show users
        when they leave this door.  If you don't wish to utilize this
        feature, leave this line blank.

NOTE:  Each of the following lines will be repeated for each publication
       you plan on offering.

10)      This is the description you wish to show up on the publication
        menu.  This line should be no longer than 60 characters.

11)      The full drive and path to the directory that contains the
        READROOM.TOC file (below) for this publication as well as all of
        the articles to be viewed in this publication.

12)     YES or NO, depending on whether you wish to allow users to download
        the file named in the READROOM.TOC file (below).  If you run a multi-
        node system and since this flag is set in the configuration file, you
        may allow users on a private node to d/l the file while not allowing
        those on the public node to do so.  The choice is up to you.
        For more information on setting up the system to allow
        downloads, please see Appendix C at the end of this document.

13)     Advanced Features Line.
          If you don't wish to utilize the Advanced Features, please
          leave this line blank or use the RESERVED key word.
          The Advanced Features line, if enabled, must consist of at
          least 3 words.
                1. NOLOG or the full drive\path\filename of the log file
                   for this publication.  This log will track those who
                   open this publication.
                2. Minimum security level neccessary to open this pub-
                   lication.  If you wish to disable this feature, enter
                   a 0.
                3. File template to be used by IMPORT utility.  Please
                   see IMPORT.DOC for more details.  If you are not
                   planning on using this feature, or wish to disable it
                   on a pub by pub basis, just add NO as the third
                   option.  Please make sure it is uppercase.
        NOTE: As additional features are added to READROOM door, they
        will probably be defined by options specified on this line.

Repeat lines 10 through 13 for each publication you wish to offer up to a
maximum of 99 publications.  If you enter more than 99, only the first
99 will be used.

NOTE:   A seperate configuration file must be created for each node you
intend to run READROOM on.

        Next, you will need to create a directory that will hold the
articles you wish to have displayed.  You will need to have a seperate
directory for each publication you intend to display with READROOM door.
In this directory you will place:
        1)  Articles to be viewed
        2)  Archived version of the articles above (optional)
        3)  READROOM.TOC
The READROOM.TOC acts as an index to the articles available that
READROOM door needs to run.  Having this file separate from the
configuration file should make life easier for sysops running multi-node
systems and whose publications change frequently.

        To create READROOM.TOC, please use the following format:

PIM9204.ZIP
PIM
Poetry In Motion
April 1992                      Vol. 12, Issue 4
ART1
ART2
ART3
ART4
...
...
...
ART99

1)      This line defines the file you wish to have available to users to
        download.  If you do not intend to offer this function, you must at
        least leave this line blank.  Since the ability to d/l is set in the
        configuration file you may have a file name here even if you aren't
        allowing it.

2)      This line is the name of the welcome file you wish displayed to
        the user as they first enter the door.  Your file should have no
        extension.  The name should be the name of the ASCII file you wish
        displayed.  If a user is in the color mode, MPD will look for a
        file that is the same as the one you name in this line except that
        the color version will have the letter G tacked on the end.  If that
        file is not found, it will show the original file.  In the
        example above, a color user would be shown the file PIMG.


3)      This line is for the first header that appears over READROOM's menu.
        Normally you would want to place the name of the publication here.

4)      This line is for the second header that appears over READROOM's menu.
        Normally you would place the issue number and date here, or what ever
        text tickles your fancy.

5-104)  These lines are where you define what files are available for
        viewing.  There should be one listing per line, to a maximum of
        99 files.  The first thing on each line should be the complete
        drive\path\filename of the ASCII (non-color) file to be viewed.
        For color users, READROOM will tack on a G at the end of the
        filename.  (See number 6 above)  Following this you will put at
        least one space before starting the file description that will
        appear on the menu.  This description can be no longer than 59
        characters.

┌────────────────────┐
│  Operation         │
└────────────────────┘

   Setup
   ─────
        To run READROOM door, you will need to create a batch file that
will launch the door.  For example:
                @echo off
                d:
                cd \readroom
                readroom readroom.cnf
will work with GAP.  Some other BBSes require that you call the BBS
software at the end of a door batch file.   Check with your BBS
documentation.

MULTI-NODE BBS NOTE:
        READROOM will run on multiple node setups, but you must create
a seperate configuration file for each node.  The only line that should
change between any of the configuration files will probably be the first
line (showing location of DOOR.SYS file for that node).

        You may set up multiple configurations of READROOM by creating a
different batchfile/.cnf file for each occurance of the door.
In doing so, you MUST remember that the paths you list in the .CNF
files should be the full drive\path\filenames, or at bare minimum, the
path\filename relative to where READROOM.EXE is located.

┌────────────────────┐
│  Support           │
└────────────────────┘

        READROOM is fully supported by it's programmer Michael J. Gibbs
through Exhibit A Communications.  He can be reached in the following
manners:
        1) Intelec network
                conferences monitored:
                        SYSOP
                        PCRELAY
                        BBS DOORS
                        PROGRAMMING
                        C PROGRAMMING
                        INTELEC ADMIN
        2) MediaNET network          node id:->EXHIBITA
                conferences monitored:
                        MEDIANET ADMIN
                        PRO PHOTO
                        MEDIANET CHAT
        2) RaceNet network           node id:->EXHIBITA
                conferences monitored:
                        EXHIBITA
                        OFFROAD
                        RACENET SYSOPS
        3) InfoMat BBS [phone]
                forum 7 is support for Exhibit A Programs
        4) CI$  #72246,1653
        5) Orange County Information Network
                        EXHIBITA forum
        6) FidoNet support offered through The Puffins Nest BBS
                        [phone] (1:261/1129)
                        Latest version of the door Freq'able using
                        "magic name" of READROOM.

┌────────────────────┐
│  Legal Disclaimer  │
└────────────────────┘
(small print on<g>)
        As with any program, every attempt is made by the programmer to
kill all the bugs in the software before it is release to the public.
Since this is all but impossible, it is recommended that new software
should only be run (for the first time at least) when a current backup
of your hard disk is available.  When shareware is released for public
evaluation, there is little that can be done on the programmer's end to
prevent others from infecting the program with viruses or making
unauthorized changes to the program.  AS SUCH, user agrees to hold
harmless MICHAEL J. GIBBS, INFOMAT BBS and EXHIBIT A COMMUNICATIONS in
regards to any personal, physical, emotion, financial, sexual or other
damage that may occur to hardware, software or the user that may arise
from the use of this program.  Use of this program is considered to be
acceptance of these conditions.
        This program remains the copyrighted work of Exhibit A
Communications.  When you register the program, you are granted a
license to use this program on one (1) BBS system, regardless of how
many nodes are active.  You may sell your registered number to another
if the following conditions are met:
        1) All copies of the software and any documentation are
                transferred to the new owner.
        2) You must discontinue use of the program following the sale.
        3) The new owner must contact Exhibit A Communications to update
                our user records.
        This program may not be sold in it's unregistered form.  It is
intended to be distributed freely.  Pay BBS systems are exempt from this
requirement provided they are not charging specifically for access to
this one program.  Shareware distributors/User Groups may charge a nominal
copying/library fee not to exceed $7.00.
(small print off<g>)

┌────────────────────┐
│  Special Thanks    │
└────────────────────┘

        Special thanks go out to:
                My wife Lori and son Bobby for tolerating my weird ways.

┌────────────────────┐
│  Appendix          │
└────────────────────┘


   Appendix A
   ──────────
                        ┌────────────────────┐
                        │ HISTORY:  READROOM │
                        └────────────────────┘
Version         Date            Fixes, Changes, etc.
───────         ────────        ─────────────────────────────────────
2.0             04/12/93        Released version 2.0 to the public!
                                Fixed bug that prevented prompt from appearing
                                in publications with < 15 articles and
                                downloading disabled.

1ß8             04/08/93        Fixed display problems with M in More prompt
                                not disappearing.  Added file transfers to
                                logging capabilities.

1ß7             03/08/93        Added filter to prevent displaying files
                                starting with an asterick (*).
                                Added AutoRead support to door to match
                                features in READER.

1ß5             01/19/93        Added support for [ANSIART] files.  If
                                this phrase is included at the head of a file,
                                then door will display file in NonStop mode.

1ß4             12/29/92        Improved incorrect key handling.  Prevents
                                menu from being redrawn if user presses an
                                invalid key.  Should keep those 2400 baud
                                users happy <g>(suggested by Carey Shibata.

1ß3             12/16/92        Added support for up to 99 different
                                publications.  Added additional checks
                                to prevent non-existant publications from
                                being displayed.

1.2             08/24/92        Fixed ASCII/ANSI file display problem that
                                caused first (for remote users) and second
                                (for local users) lines of each screen of text
                                to scroll off top of screen.

1.1             08/03/92        Released v1.1.

1ß8             07/29/92        Externalized transfer protocols.

1ß7             07/15/92        Added advanced features:
                                        minimum security level to open pub
                                        optional logging of users in and out
                                                of a publication

1.0             06/05/92        First public release of door!

1ß6             06/02/92        Added support for 15 different
                                publications.  Released for final Beta
                                testing.

1ß5             05/20/92        Improved appearance of the command line
                                when download is enabled.

1ß4             05/18/92        Added ability to d/l this issue from
                                within the door.

1ß3             05/13/92        Seperated configuration file from the
                                table of contents to optimize for use on
                                multi-node BBSes.

1ß2             05/11/92        Fixed error that caused user to choose
                                a number higher than the maximum number
                                of documents.

1ß1             04/08/92        First official beta test.  Support for
                                up to 99 files to be viewed.


   Appendix B
   ──────────
                                Future Improvements

        Shortly thereafter, if the need dictates, I will add the ability for
certain specified users to upload an updated publication.  READROOM will then
launch an update batch file that will replace the old files with the new ones
and update the READROOM.TOC accordingly!

        If people come across stable publication formats (like USA Today's or
others) please forward them to me and I will try and create some small (.COM)
programs to automatically create the READROOM.TOC file.


   Appendix C
   ──────────
                    Setting up READROOM for downloading publications

        If you decide to allow users to download publication, there are
a few steps you must take first.
        1)  Unzip DL-FILES.ZIP into the directory containing
                READROOM.EXE.
        2)  Make changes to the READROOM configuration so that the
                allow-download-line (see above) for each publication
                reads YES.
        3)  If you intend to offer only the DSZ protocols then you can
                use the RR-Sx.BAT files as they are.

        If you wish to add more transfer protocols, please do the
        following:
        1)  Add the letter you wish to have the user press to select the
                protocol to PROTO.DAT.  This file should contain the
                letter (uppercase) or number used to call the protocol,
                one per line.  See sample PROTO.DAT for examples.
        2)  Add the letter to the PROTO and PROTOG menu files.
        3)  Create a RR-Sx.BAT file where x is the letter or number
                defined in PROTO.DAT.  READROOM will pass the
                following parameters to the batch file:
                %1      Comm Port Number
                %2      DTE (computer to modem) speed
                %3      The full drive\path\filename of the file to
                        transfer
                %4      User's actual baud rate (modem to modem)

                        POINTS TO REMEMBER!

        1)  Make sure that the filename in READROOM.TOC does NOT include
            a drive or path.  It should list the filename ONLY.
            READROOM will add the filename to the drive\path listed in
            the READROOM's configuration file for the given publication.

        2)  Make sure that the file DOES exist in the directory.